Skip to content

Search: Add docs headings to index#26531

Closed
shilman wants to merge 6 commits into
nextfrom
shilman/add-searchable-headings
Closed

Search: Add docs headings to index#26531
shilman wants to merge 6 commits into
nextfrom
shilman/add-searchable-headings

Conversation

@shilman

@shilman shilman commented Mar 16, 2024

Copy link
Copy Markdown
Member

Closes N/A

What I did

Work in progress

  • Upgraded @storybook/docs-mdx to a version that extracts Markdown headings
  • Added a heuristic to add synthetic headings for Autodocs - this prob
  • Updated test snapshots

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

For now, run a sandbox and manually inspect its /index.json

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@nx-cloud

nx-cloud Bot commented Mar 16, 2024

Copy link
Copy Markdown

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 192bf87. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@shilman shilman changed the title Search: Add searchable headings to index Search: Add docs headings to index Mar 16, 2024
@shilman shilman added feature request ui: search ci:normal Run our default set of CI jobs (choose this for most PRs). labels Mar 17, 2024
@March-Wind

Copy link
Copy Markdown

mark . I really need it

@kroeder

kroeder commented Jan 17, 2025

Copy link
Copy Markdown
Member

@March-Wind as soon as #30130 (comment) got merged, I'll try it out in this branch
The linked fix is hopefully the last missing piece to make this work. I'll then discuss further steps with @shilman and see if we can push this forward 🤞

@valentinpalkovic

Copy link
Copy Markdown
Contributor

Closing due to inactivity. Please feel free to reopen the PR if you would like to continue working on it.

@kroeder kroeder reopened this Dec 1, 2025
@kroeder

kroeder commented Dec 1, 2025

Copy link
Copy Markdown
Member

@valentinpalkovic @shilman I'd like to finish this and prioritized this with my team internally. I start with figuring out at what sate I left the PR but the reason why I haven't finished it last time is that I need help from someone of you to get the last 10-20% done

I'll contact you as soon as I'm ready and we'll figure out a slot where we maybe can talk about this. Would that be ok for you?

@kroeder kroeder self-assigned this Jan 19, 2026
@kroeder

kroeder commented Jan 19, 2026

Copy link
Copy Markdown
Member

@shilman @valentinpalkovic I started from scratch because merging next into this PR was not easy. I also wanted to preserve the changes here and started a fresh PR in #33593

I hope that's fine for you as well

@kroeder kroeder closed this Jan 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:normal Run our default set of CI jobs (choose this for most PRs). feature request ui: search

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants